NocoBase APIを利用する

栁澤一貴

2024.04.12

こんにちは、海好きの栁澤です。 NocoBase APIを叩いてみましたので方法をまとめます。

NocoBaseはUI上から出来る各種操作をAPIから行うことができます。もちろんレコードの操作・取得も可能となっており、他システムとの連携が容易です。

Plugin: api-keysを有効にする

Plugin managerからAuth: API keysを有効にします。

有効にすると、設定メニューに「API Keys」の項目が追加されます。

設定メニュー > API keysから認証に用いるBearerトークン(JWT)を発行します。

Key Name: キーの利用目的などを記載し、何に使われているかわかる名称を記入。
Role: 発行するキーのロールを指定。トークンに割り当てたロールに応じて認可が行われます。
Expiration: トークンの有効期限を指定。

送信ボタン押下後、トークンが発行されます。 発行したキーは再度確認することができませんのでご注意ください。

Chrome拡張: Talend API Testerを利用してNocoBase APIを叩いてみます。 Bearer認証ですので、下記のようにリクエストのAuthorizationヘッダーに発行したトークンを付与します。 Authorization: bearer {token}

今回は/{collectionName}:list を叩いてみます。 {collectionName}の箇所はコレクション識別子に置き換えます。（コレクション名ではない）

無事コレクションの内容を取得できました。レスポンスを見る限り、ページングにも対応されているようです。